home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / basic / libkey.com / LIBKEY.DOC < prev    next >
Encoding:
Text File  |  1991-02-22  |  11.9 KB  |  321 lines
  1.                                        1
  2.  
  3.  
  4.                                 --- LIBKEY ---
  5.                                    Ver. 1.0
  6.                 A PROGRAMMER'S UTILITY FOR LIBRARY MAINTENANCE
  7.  
  8.  
  9.                        (c)Copyright 1989, 1990, 1991 by
  10.                                  John M. Coon
  11.                               11 Meadow Wood Dr.
  12.                              Fairport, N. Y. 14450
  13.                            Compuserve ID# 73067,1666
  14.  
  15.  
  16.      IMPORTANT:
  17.  
  18.      This program may be distributed and copied freely as long as
  19.      this documentation file is included. LIBKEY is a Shareware
  20.      product and is intended to be used by individuals as a tool for
  21.      QUICKLIBRARY and LIBRARY maintenance applicable to MICROSOFT's
  22.      QUICKBASIC, QUICK C, MASM, LIB and LINK. LIBKEY is a copyrighted
  23.      program and may not be sold individually, included as part of
  24.      prepackaged software or for any commercial purpose.
  25.      Disk distributors of Shareware or User Supported software may
  26.      distribute LIBKEY for a fee that does not exceed $6 which
  27.      covers copying and handling.
  28.  
  29.      ABOUT LIBKEY:
  30.  
  31.      My concept when I started this project in 1989 was to finish
  32.      with a program that automated as many functions as possible for
  33.      QuickLibrary and Library Maintenance. Some functions which
  34.      did not seem feasible when I started fell into place along the
  35.      way, and a lot was learned about LINK and LIB in the process.
  36.  
  37.      There were two programs that resulted from that original
  38.      project, (FASTLIB and FASTQLB). FASTLIB was identical to FASTQLB
  39.      except that it did not contain the "Make QLB" routines. Both of
  40.      the programs, while functional suffered from some major
  41.      deficiencies, not the least of which, was their inability to
  42.      handle large libraries.
  43.  
  44.      This new version called LIBKEY is the result of a major rewrite
  45.      which combines the two original programs and incorporates many
  46.      suggestions received from programmers who tried the originals.
  47.  
  48.      LIBKEY will handle libraries with as many as 1000 object
  49.      modules. This should prove useful to programmers who own some
  50.      of the more lengthy commercial and shareware libraries.
  51.  
  52.      LIBKEY will link your libraries to the QuickLibrary utility of
  53.      your choice. Although not tried, it should prove useful to QUICK C
  54.      programmers as well.
  55.  
  56.      String Sort and Search routines have been improved and a
  57.      printer routine bug has been fixed.
  58.  
  59.      LINK switches may now be added to LINK/Q, the default call for
  60.      Quicklibrary linking.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                                        2
  68.  
  69.  
  70.  
  71.      USING LIBKEY:
  72.  
  73.      The program displays the Main menu on the left side of the screen.
  74.      When called by the program a File selection window appears on the
  75.      right half of the screen.
  76.  
  77.      Main Menu Options are:
  78.  
  79.      1> DISPLAY FILES
  80.         Displays Filespec Files in current directory
  81.  
  82.      2> SET FILE SPEC (*.*)
  83.         Allows changing the File display parameters to *.LIB or
  84.         *.OBJ etc. for displaying files in the current directory. All
  85.         directory calls generated by the program assume all needed
  86.         files are in the current directory or path. LIB.EXE, LINK.EXE
  87.         and your QLB Utility must either be in the current directory
  88.         or in your DOS path.
  89.  
  90.      3> LINK OPTIONS
  91.         The program displays the current Link options just above the
  92.         Main Menu. This menu option lets you change the Link options
  93.         as necessary. The "/Q" switch is permanently set as a default
  94.         and options you add are appended to this switch.
  95.  
  96.      4> LIB FUNCTIONS
  97.  
  98.           1> EXTRACT OBJECT MODULES
  99.              This option extracts OBJ Modules from a Library you
  100.              select and mark. It does not remove OBJ Modules from
  101.              the Library but pulls out a copy and puts it in the
  102.              current directory. LIBKEY prompts you for a Library
  103.              name, displays the Library and lets you mark one.
  104.              After you have selected the Library, the program
  105.              displays all of the OBJ Modules contained within the
  106.              Library. You then scroll thru the list and mark the
  107.              individual OBJ Modules for extraction. The proper
  108.              response and batch file is generated and then
  109.              executed, leaving the selected files in the current
  110.              directory.
  111.           2> BUILD NEW LIBRARY
  112.              This option prompts you for a Library name. It then
  113.              checks the current directory for any matching names
  114.              and if it finds one prompts you for a new name. The
  115.              program then asks if you want to include an existing
  116.              Library and if yes displays all Libraries in the
  117.              current directory. You are then asked if you want to
  118.              include OBJ Modules in your new Library and if yes
  119.              all OBJ Files in the current directory are displayed.
  120.              After your selections are complete the Response and
  121.              Batch files are generated and executed.
  122.           3> ADD OBJ MODULES
  123.              This option allows you to add OBJ Modules to an
  124.              existing Library.  It displays OBJ Modules in the
  125.              current directory for marking and inclusion within
  126.              an existing Library.
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.                                        3
  134.  
  135.  
  136.  
  137.           4> REMOVE OBJ MODULES
  138.              This option first displays the Libraries in the
  139.              current directory for you to mark one. It then
  140.              displays all of the OBJ Modules within the marked
  141.              Library for you to mark for removal. This option DOES
  142.              PERMANENTLY REMOVE OBJ Modules from the Library.
  143.           5> LIST LIB (OBJ MODULES)
  144.              This option first asks if you want the OBJ Modules
  145.              listed to Screen or Printer. It then asks you to
  146.              select a Library from the displayed Libraries. All
  147.              OBJ Modules are then displayed either in the screen's
  148.              display window for scrolling or to your printer in
  149.              the standard Library List format.
  150.  
  151.      5> MAKE QLB
  152.         This option first asks you to input the name of the QLB
  153.         Utility to use for linking or accept the default, which is
  154.         BQLB45.LIB, used with QUICKBASIC Ver. 4.5. The selected or
  155.         default QLB Utility is displayed just above the File display
  156.         portion of the screen on the right hand side of the display.
  157.         You are then asked if you want to include a library or
  158.         Libraries in your QuickLibrary. If the answer is yes all
  159.         Libraries in the current directory are displayed for you to
  160.         mark for inclusion.
  161.         You are then asked if you want to include OBJ files in your
  162.         QuickLibrary. If the answer is yes all OBJ Files in the current
  163.         directory are displayed for you to mark for inclusion. You
  164.         may pick one Library or one Object File or many of each for your
  165.         QuickLibrary. The Program then prompts you for a QuickLibrary
  166.         name. You must include the extension .QLB in the name.
  167.         LIBKEY then generates the Response file for LINK to make
  168.         the new QuickLibrary. After the Response and Batch File
  169.         has been generated LIBKEY SHELL's to system and makes the QLB
  170.         while you watch for any errors that are generated by LINK
  171.         for unresolved Externals etc. in your selected Libraries
  172.         or OBJ Modules. A keypress is required to return to the
  173.         program.
  174.  
  175.      6> HELP SCREEN
  176.         Displays LIBKEY Help.
  177.  
  178.      7> DOS SHELL
  179.         Allows shelling to DOS for directory maintenance.
  180.  
  181.      8> EXIT TO DOS
  182.         Exit to system after a decision window.
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.                                        4
  200.  
  201.  
  202.  
  203.      LIBKEY REQUIREMENTS:
  204.  
  205.      The program will work on floppies, but bear in mind that
  206.      COMMAND.COM and your working utility programs must either
  207.      be in the current directory or in your path. The program also
  208.      generates response, batch, and list files rather quickly
  209.      so disk space could be at a premium when using floppies. For
  210.      that reason a Hard Drive is highly recommended.
  211.  
  212.      LIBKEY has been tested O.K. on Mono, CGA, EGA and VGA equipped
  213.      machines.
  214.  
  215.      COMPILER:
  216.  
  217.      LIBKEY was compiled using MICROSOFT's QUICKBASIC Ver. 4.5.
  218.      Some of the routines in LIBKEY are from Crescent Software's
  219.      QUICKPAK Library, an invaluable programming tool.
  220.  
  221.      QUICKPAK - Copyright Crescent Software
  222.      QUICKBASIC, QUICK C, LIB, LINK, COMMAND.COM -
  223.                   Copyright Microsoft Corp.
  224.  
  225.  
  226.      REGISTRATION:
  227.  
  228.      LIBKEY is shareware and you are asked to evaluate this software
  229.      for a reasonable amount of time. If after that time you feel
  230.      that the program is useful to your programming efforts you may
  231.      register LIBKEY by sending the version number of LIBKEY that you
  232.      have and the sum of $20 to the author.  You will receive the latest
  233.      version of LIBKEY, if a newer version has been released, and an
  234.      acknowledgement and registration number by return mail.
  235.      As a registered user, you may contact me thru Compuserve or
  236.      direct Mail if you have any questions, suggestions or problems.
  237.  
  238.      LIBKEY LIMITATIONS:
  239.  
  240.      LIBKEY will not resolve some of the common errors encountered
  241.      when building libraries from multiple modules. The user is
  242.      expected to have a basic understanding of the library and
  243.      linking process. If errors are detected on the screen while
  244.      LIB and LINK are working, list the library to the printer
  245.      and identify the modules or routines in question that need
  246.      to be included in your library.  Some Quicklibraries may require
  247.      that the segment default for LINK be set to a higher value
  248.      with the LINK switch option.
  249.  
  250.  
  251.      DISCLAIMER OF LIABILITY:
  252.  
  253.      This program, its use, and operation are provided "AS IS"
  254.      without warranty of any kind, either expressed or implied.
  255.      The entire risk as to the quality and performance of this
  256.      program is with the user. In no event shall I, John M. Coon,
  257.      be liable for damages arising from the use or inability to
  258.      use this program.
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.          ----------------end-of-author's-documentation---------------
  288.  
  289.                         Software Library Information:
  290.  
  291.                    This disk copy provided as a service of
  292.  
  293.                         The Public (Software) Library
  294.  
  295.          We are not the authors of this program, nor are we associated
  296.          with the author in any way other than as a distributor of the
  297.          program in accordance with the author's terms of distribution.
  298.  
  299.          Please direct shareware payments and specific questions about
  300.          this program to the author of the program, whose name appears
  301.          elsewhere in  this documentation. If you have trouble getting
  302.          in touch with the author,  we will do whatever we can to help
  303.          you with your questions. All programs have been tested and do
  304.          run.  To report problems,  please use the form that is in the
  305.          file PROBLEM.DOC on many of our disks or in other written for-
  306.          mat with screen printouts, if possible.  The P(s)L cannot de-
  307.          bug programs over the telephone.
  308.  
  309.          Disks in the P(s)L are updated monthly, so if you did not get
  310.          this disk  directly from the P(s)L,  you should be aware that
  311.          the files in this set may no  longer be the current versions.
  312.  
  313.          For a copy of the latest monthly software library newsletter
  314.          and a list of the 2,000+ disks in the library, call or write
  315.  
  316.                         The Public (Software) Library
  317.                               P.O.Box 35705
  318.                            Houston, TX 77235-5705
  319.                                (713) 524-6394
  320.  
  321.